FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.us.davinci-dtr#current (32 ms)

Package hl7.fhir.us.davinci-dtr
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/davinci-dtr/https://build.fhir.org/ig/HL7/davinci-dtr/OperationDefinition-DTR-Questionnaire-next-question.html
Url http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/DTR-Questionnaire-next-question
Version 2.1.0
Status active
Date 2024-12-16T23:16:21+00:00
Name DTRNextQuestion
Title DTR Next Question Operation
Experimental False
Realm us
Authority hl7
Description The Next Question operation is used for *adaptive questionnaires*. For specific details, see the [SDC Next Question operation](http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question).
Type true
Kind operation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition DTR-Questionnaire-next-question

URL: [base]/Questionnaire/$next-question

Input parameters Profile:DTR Next Question Input Parameters

Output parameters Profile:DTR Next Question Output Parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INquestionnaire-response-in1..1Resource

The DTR QuestionnaireResponse Profile of the QuestionnaireResponse resource with a contained Questionnaire. When invoking the operation for the first time, neither the QuestionnaireResponse nor the contained Questionnaire will have any items, as no questions are yet known. In subsequent calls, the QuestionnaireResponse will include answers to all required questions asked so far and the contained QuestionnaireResponse will remain the same as provided back from the operation in the preceding response.

OUTquestionnaire-response-out1..1Resource

The DTR QuestionnaireResponse Profile of the QuestionnaireResponse resource with a contained Questionnaire. The Server updates the QuestionnaireResponse's contained Questionnaire by appending with the next question or questions ittems and any score or instruction items and returns the QuestionnaireResponse (with all answers completed thus far plus any calculated scores) as this parameter. When the questionnaire is complete, the Server updates the status of the QuestionnaireResponse resource parameter to complete.

To return a calculated score for the questionnaire or group of items, the service may return a readOnly question with the score value in the corresponding QuestionnaireResponse.item. The extension questionnaire-hidden can be included on the Questionnaire.item to indicate to the client that it should not be displayed to the end user


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "DTR-Questionnaire-next-question",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DTR-Questionnaire-next-question</b></p><a name=\"DTR-Questionnaire-next-question\"> </a><a name=\"hcDTR-Questionnaire-next-question\"> </a><a name=\"DTR-Questionnaire-next-question-en-US\"> </a><p>URL: [base]/Questionnaire/$next-question</p><p>Input parameters Profile:<a href=\"StructureDefinition-dtr-next-question-input-parameters.html\">DTR Next Question Input Parameters</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-dtr-next-question-output-parameters.html\">DTR Next Question Output Parameters</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>questionnaire-response-in</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The <a href=\"StructureDefinition-dtr-questionnaireresponse.html\">DTR QuestionnaireResponse Profile</a> of the QuestionnaireResponse resource with a <em>contained</em> Questionnaire. When invoking the operation for the first time, neither the QuestionnaireResponse nor the contained Questionnaire will have any items, as no questions are yet known. In subsequent calls, the QuestionnaireResponse will include answers to all required questions asked so far and the contained QuestionnaireResponse will remain the same as provided back from the operation in the preceding response.</p>\n</div></td></tr><tr><td>OUT</td><td>questionnaire-response-out</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The <a href=\"StructureDefinition-dtr-questionnaireresponse.html\">DTR QuestionnaireResponse Profile</a> of the QuestionnaireResponse resource with a <em>contained</em> Questionnaire. The Server updates the QuestionnaireResponse's contained Questionnaire by appending with the next question or questions ittems and any score or instruction items and returns the QuestionnaireResponse (with all answers completed thus far plus any calculated scores) as this parameter. When the questionnaire is complete, the Server updates the status of the QuestionnaireResponse resource parameter to <code>complete</code>.</p>\n</div></td></tr></table><div><p>To return a calculated score for the questionnaire or group of items, the service may return a <code>readOnly</code> question with the score value in the corresponding QuestionnaireResponse.item. The extension <code>questionnaire-hidden</code> can be included on the Questionnaire.item to indicate to the client that it should not be displayed to the end user</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/DTR-Questionnaire-next-question",
  "version" : "2.1.0",
  "name" : "DTRNextQuestion",
  "title" : "DTR Next Question Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-16T23:16:21+00:00",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "name" : "HL7 International / Clinical Decision Support",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "The Next Question operation is used for *adaptive questionnaires*. For specific details, see the [SDC Next Question operation](http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question).",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "next-question",
  "comment" : "To return a calculated score for the questionnaire or group of items, the service may return a `readOnly` question with the score value in the corresponding QuestionnaireResponse.item. The extension `questionnaire-hidden` can be included on the Questionnaire.item to indicate to the client that it should not be displayed to the end user",
  "base" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question",
  "resource" : [
    "Questionnaire"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-next-question-input-parameters",
  "outputProfile" : "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-next-question-output-parameters",
  "parameter" : [
    {
      "name" : "questionnaire-response-in",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The [DTR QuestionnaireResponse Profile](StructureDefinition-dtr-questionnaireresponse.html) of the QuestionnaireResponse resource with a *contained* Questionnaire. When invoking the operation for the first time, neither the QuestionnaireResponse nor the contained Questionnaire will have any items, as no questions are yet known. In subsequent calls, the QuestionnaireResponse will include answers to all required questions asked so far and the contained QuestionnaireResponse will remain the same as provided back from the operation in the preceding response.",
      "type" : "Resource"
    },
    {
      "name" : "questionnaire-response-out",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The [DTR QuestionnaireResponse Profile](StructureDefinition-dtr-questionnaireresponse.html) of the QuestionnaireResponse resource with a *contained* Questionnaire. The Server updates the QuestionnaireResponse's contained Questionnaire by appending with the next question or questions ittems and any score or instruction items and returns the QuestionnaireResponse (with all answers completed thus far plus any calculated scores) as this parameter. When the questionnaire is complete, the Server updates the status of the QuestionnaireResponse resource parameter to `complete`.",
      "type" : "Resource"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.